/*
 *  Copyright (C) 2010 Glauco
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.balisunrise.common;

/**
 * Contém FieldComponents para representações visualmente um Campo (Atributo)
 * de uma entidade (Classe).
 * @author Glauco
 * @version 1.0
 * @param <T> Tipo do Componente.
 */
public interface FieldLayout extends EntityField{

    /**
     * Adiciona um FieldComponent a este FieldLayout.
     * @param fieldComponent
     */
    public void addFieldComponent(FieldComponent fieldComponent);

    /**
     * Remove um FieldComponent deste FieldLayout.
     * @param fieldComponent à remover.
     * @return se o componente pertencia a este FieldLayout e foi removido.
     */
    public boolean removeFieldComponent(FieldComponent fieldComponent);

    /**
     * Retorna uma lista dos componetes (Objetos de
     * Representação Visual) para um Campo (Atributo) de uma entidade
     * (Classe).
     */
    public FieldComponent[] getFieldComponents();

    /**
     * Retorna se as componentes devem ser visualizados em uma
     * nova linha do layout.
     */
    public boolean jumpToNextRow();

    /**
     * Limpa os dados dos componentes de Representação Visual.
     */
    public void clearComponentsValues();

    /**
     * Se o campo possui um componente que possa ser requerido o
     * focus, requere o focus para o componente e retorna
     * verdadeiro, caso contrario retorna falso.
     */
    public boolean requestFocus();
}